Include receiver name in its string representation #439
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The string representation of a receiver is used in logging, and without this, it is impossible to identify which receiver is meant, from looking at the logs. Signed-off-by: Sahas Subramanian <[email protected]>
Signed-off-by: Sahas Subramanian <[email protected]>
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR enhances logging by including each receiver's name in its string representation and documents this change.
- Updated
__str__to append the receiver’s_name. - Added a release note entry for the new behavior.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frequenz/channels/_broadcast.py | Modified __str__ to include self._name |
| RELEASE_NOTES.md | Documented that __str__ now includes the name |
Comments suppressed due to low confidence (3)
src/frequenz/channels/_broadcast.py:518
- Add or update unit tests to verify that
__str__includes the receiver's name as expected, ensuring this behavior is covered.
return f"{self._channel}:{type(self).__name__}:{self._name}"
src/frequenz/channels/_broadcast.py:520
- [nitpick] Consider updating
__repr__to also include the receiver’s name for consistency and improved debugging output.
def __repr__(self) -> str:
RELEASE_NOTES.md:19
- Remove the leading extra hyphen and blank line so this bullet renders correctly (e.g., use
- The ...without a preceding blank-).
- The `__str__` representation of broadcast receivers now include the receiver's name.
cwasicki
approved these changes
Jul 8, 2025
llucax
approved these changes
Jul 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The string representation of a receiver is used in logging, and
without this, it is impossible to identify which receiver is meant,
from looking at the logs.